<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>Test Before Reference - Module</title>

        <link rel="stylesheet" href="../static/blue.css" type="text/css" media="screen" charset="utf-8" />
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

        

<!-- ============================== classes index ============================ -->
		<div id="index">
            <div id="docs">
                
            </div>
			
<h2>Index</h2>
<ul class="classList">
  <li><a href="../files.html">File Index</a></li>
  <li><a href="../index.html">Class Index</a></li>
  <li><a href="../symbolindex.html">Symbol Index</a></li>
</ul>
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/formatter.html">formatter</a></li>
	
	<li><a href="../symbols/Module.html">Module</a></li>
	
	<li><a href="../symbols/TB.html">TB</a></li>
	
	<li><a href="../symbols/Test.html">Test</a></li>
	
</ul>

		</div>
		
        <!--
        <div id="symbolList">
           <!-- constructor list -->
           
             <h3>
                 Class 
             </h3>
             <ul>
                <li >
                  <a href="../symbols/Module.html">Module</a>
                </li>
             </ul>
           
           <!-- end constructor list -->

           <!-- properties list -->
           
           
             <h3>Fields</h3>
             <ul>
               
                 <li>
                   <a href="../symbols/Module.html#failed">failed</a>
                 </li>
               
                 <li>
                   <a href="../symbols/Module.html#name">name</a>
                 </li>
               
                 <li>
                   <a href="../symbols/Module.html#passed">passed</a>
                 </li>
               
                 <li>
                   results[][]
                 </li>
               
                 <li>
                   tests[][]
                 </li>
               
             </ul>
           
           <!-- end properties list -->

           <!-- function summary -->
           
           
             <h3>Methods</h3>
             <ul>
               
                   <li>
                        <a href="../symbols/Module.html#addTest">addTest</a>
                    </li>
               
                   <li>
                        <a href="../symbols/Module.html#processResult">processResult</a>
                    </li>
               
                   <li>
                        <a href="../symbols/Module.html#run">run</a>
                    </li>
               
             </ul>
           
           <!-- end function summary -->

           <!-- events summary -->
           
           
           <!-- end events summary -->
        </div>
        -->
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				Class Module
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				Represents a group of tests.
				
				
					<p class="definedIn">Defined in: <a href="../symbols/src/_Users_collinbrooks_Dropbox_Scripts_AEScripts_BeforeEffects_src_testbefore.jsxinc.html">testbefore.jsxinc</a>.</p>
				
			</p>

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">&lt;private&gt; &lt;inner&gt; 
						<b>Module</b>(name)
				</div>
				
				<div class="description">
					<p>Defines a group of tests.</p>
					
				</div>
				
				
				
				
					
						<dl class="detailList">
						<dt class="heading">Parameters:</dt>
						
							<dt>
								<span class="light fixedFont">{String}</span>  <b>name</b>
								
							</dt>
								<dd>The name of this test group.</dd>
						
						</dl>
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			
              <div class="details">
				<div class="sectionTitle">
					Field Detail
				</div>
                <table border="1">
                    <tr>
                        <th>Name</th>
                        <th>Type</th>
                        <th>Description</th>
                    </tr>
				
                        <tr>
                            <td><b>failed</b></td>
                            <td><span class="light">{Number}</span></td>
                            <td><p>The number of tests that have failed.</p></td>
                        </tr>
                  <!--
                  <div class="member">
					<a name="failed"> </a>
					<div class="fixedFont">
                      <div class="modifiers">
                      </div>
					
					<span class="light">{Number}</span>
					<b>failed</b>
					
					</div>
					<div class="description">
						<p>The number of tests that have failed.</p>
						
						
					</div>
					
					

						
						
						
						
                  </div>
                -->
				
                        <tr>
                            <td><b>name</b></td>
                            <td><span class="light">{String}</span></td>
                            <td><p>The name of this module.</p></td>
                        </tr>
                  <!--
                  <div class="member">
					<a name="name"> </a>
					<div class="fixedFont">
                      <div class="modifiers">
                      </div>
					
					<span class="light">{String}</span>
					<b>name</b>
					
					</div>
					<div class="description">
						<p>The name of this module.</p>
						
						
					</div>
					
					

						
						
						
						
                  </div>
                -->
				
                        <tr>
                            <td><b>passed</b></td>
                            <td><span class="light">{Number}</span></td>
                            <td><p>The number of tests that have passed.</p></td>
                        </tr>
                  <!--
                  <div class="member">
					<a name="passed"> </a>
					<div class="fixedFont">
                      <div class="modifiers">
                      </div>
					
					<span class="light">{Number}</span>
					<b>passed</b>
					
					</div>
					<div class="description">
						<p>The number of tests that have passed.</p>
						
						
					</div>
					
					

						
						
						
						
                  </div>
                -->
				
                        <tr>
                            <td><b>results[]</b></td>
                            <td><span class="light">{Array}</span></td>
                            <td><p>An array of result objects.</p></td>
                        </tr>
                  <!--
                  <div class="member">
					<a name="results[]"> </a>
					<div class="fixedFont">
                      <div class="modifiers">
                      </div>
					
					<span class="light">{Array}</span>
					<b>results[]</b>
					
					</div>
					<div class="description">
						<p>An array of result objects.</p>
						
						
					</div>
					
					

						
						
						
						
                  </div>
                -->
				
                        <tr>
                            <td><b>tests[]</b></td>
                            <td><span class="light">{Array}</span></td>
                            <td><p>An array of Test objects belonging to this
module.</p></td>
                        </tr>
                  <!--
                  <div class="member">
					<a name="tests[]"> </a>
					<div class="fixedFont">
                      <div class="modifiers">
                      </div>
					
					<span class="light">{Array}</span>
					<b>tests[]</b>
					
					</div>
					<div class="description">
						<p>An array of Test objects belonging to this
module.</p>
						
						
					</div>
					
					

						
						
						
						
                  </div>
                -->
				
                    </table>
              </div>
			

<!-- ============================== method details ========================= -->		
			
              <div class="details">
				<div class="sectionTitle">
					Method Detail
				</div>
				
                  <div class="member">
					<a name="addTest"> </a>
					<div class="fixedFont">
                      <div class="modifiers">
                      </div>
					<span class="light">{<a href="../symbols/Test.html">Test</a>}</span>
					<b>addTest</b>(t)
					
					</div>
					<div class="description">
						<p>Adds a test to this module's array of tests.</p>
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{<a href="../symbols/Test.html">Test</a>}</span> <b>t</b>
									
								</dt>
								<dd>The test to add to this module.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{<a href="../symbols/Test.html">Test</a>}</span> The test added to this module.</dd>
							
							</dl>
						
						
						

                  </div>
				
                  <div class="member">
					<a name="processResult"> </a>
					<div class="fixedFont">
                      <div class="modifiers">
                      </div>
					<span class="light">{<a href="../symbols/Module.html">Module</a>}</span>
					<b>processResult</b>(r)
					
					</div>
					<div class="description">
						<p>Adds the given result to the Module's list of results as well as
updates the number of passed/failed tests.</p>
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>r</b>
									
								</dt>
								<dd>The result object to process.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{<a href="../symbols/Module.html">Module</a>}</span> This Module; useful for chaining.</dd>
							
							</dl>
						
						
						

                  </div>
				
                  <div class="member">
					<a name="run"> </a>
					<div class="fixedFont">
                      <div class="modifiers">
                      </div>
					<span class="light">{Array}</span>
					<b>run</b>()
					
					</div>
					<div class="description">
						<p>Runs the Module's set of tests.</p>
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Array}</span> An array of result objects.</dd>
							
							</dl>
						
						
						

                  </div>
				
              </div>
			
			
<!-- ============================== event details ========================= -->		
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both;text-align:center">
			&copy;2011<br />
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Fri Sep 16 2011 20:12:35 GMT-0500 (CDT)
		</div>
	</body>
</html>
